ODDragItemIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODDragItemIterator

Superclasses
ODObject
Subclasses
none

An object of the ODDragItemIterator class provides access to the content storage units for all drag items of a drag-and-drop object.

Description
Each drag item is an item being copied or moved in a drag-and-drop operation. Its content storage unit contains the data being transferred. Once a drag operation is initiated (by calling its drag-and-drop object's StartDrag method (page 195)), the drag-and-drop object notifies a part when the mouse pointer passes over one of its facets. In addition to providing the mouse location, the drag-and-drop object also supplies the part with a drag-item iterator. Similarly, if the mouse pointer is released over a frame, the part is notified of the mouse location and supplied with a drag-item iterator. In both cases, the part might use the drag-item iterator to examine each drag item from the incoming drag operation and decide whether to provide destination feedback and whether to accept the drop event.
While you are using a drag-item iterator, you should not modify the list of drag items. You must postpone adding items to or removing items from the list of drag items until after you have deleted the iterator.
For more information related to drag-and-drop objects, see the ODDragAndDrop class description (page 187). For more information on drag-and-drop operations, see the chapters on data transfer and OpenDoc runtime features in the OpenDoc Programmer's Guide for the MacOS. For more information on accessing objects through iterators, see "Accessing Objects Through Iterators" on page 473 in OpenDoc Programmer's Guide.

Methods
This section presents summary descriptions of the ODDragItemIterator methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Accessing

First
Begins the iteration and returns a reference to the first storage unit in the iteration sequence.
Next
Returns a reference to the next storage unit in the iteration sequence.
Iterator Testing

IsNotComplete
Returns a Boolean value that indicates whether the iteration is incomplete.

Methods
First
IsNotComplete
Next